﻿/*
    This file is part of nDoctor Light

    NDoctor is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    NDoctor is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with NDoctor.  If not, see <http://www.gnu.org/licenses/>.
*/
namespace Probel.Ldoc.Shell.Tools
{
    public interface ISavable
    {
        #region Properties

        /// <summary>
        /// Gets a value indicating whether this instance has been modified.
        /// </summary>
        /// <value>
        /// <c>true</c> if this instance is modified; otherwise, <c>false</c>.
        /// </value>
        bool IsModified
        {
            get;
        }

        #endregion Properties

        #region Methods

        /// <summary>
        /// Saves the unchanged data of this instance.
        /// </summary>
        /// <returns><c>True</c> if navigation should be cancelled. Otherwise <c>False</c></returns>
        bool ManageSaveFlow();

        #endregion Methods
    }
}